home *** CD-ROM | disk | FTP | other *** search
/ Sun Solutions 1997 April to September / Sun Solutions CD - APR '97 - SEP '97 (704-3778-12 Rev. H)(Sun Microsystems, Inc.)(1997).iso / products / Hyperion / src / workmandb.doc < prev    next >
Text File  |  1997-02-26  |  11KB  |  331 lines
  1.  
  2.  
  3.  
  4. workmandb(5)              FILE FORMATS               workmandb(5)
  5.  
  6.  
  7.  
  8. NAME
  9.      workmanrc, workmandb - database and  preferences  files  for
  10.      workman
  11.  
  12. SYNOPSIS
  13.      $HOME/.workmanrc or value of WORKMANRC variable
  14.  
  15.      $HOME/.workmandb or value(s) of WORKMANDB variable
  16.  
  17. DESCRIPTION
  18.      The .workmandb file stores information about compact  discs.
  19.      It is generated by _w_o_r_k_m_a_n(1) based on user input.  Its com-
  20.      panion file, .workmanrc, stores user  preferences  for  each
  21.      disc.   The  distinction  between the two is that .workmandb
  22.      contains only the hard information  about  a  CD  (the  disc
  23.      name,  artist, track titles, etc.) and is often shared among
  24.      several users.  .workmanrc, on the other hand, contains set-
  25.      tings  like  the  default  volumes of particular tracks, the
  26.      numbers of tracks to be avoided, and so  forth.   Each  user
  27.      generally  maintains  a private .workmanrc, even if a shared
  28.      .workmandb is being used.
  29.  
  30.      Though _w_o_r_k_m_a_n(1) stores different information in each file,
  31.      both  files  have  an  identical format; most of this manual
  32.      page will not distinguish between the two.  Each line of the
  33.      file is of the form
  34.  
  35.      [s-]keyword    [_o_p_t_i_o_n_a_l _w_h_i_t_e_s_p_a_c_e-_s_e_p_a_r_a_t_e_d _a_r_g_u_m_e_n_t_s]
  36.  
  37.      Empty lines are ignored.  Lines starting  with  unrecognized
  38.      keywords are retained and written back out verbatim when the
  39.      database is saved.  The program preserves  the  ordering  of
  40.      unrecognized  lines,  and  their  positions  relative to the
  41.      track information.  This allows the database to be  extended
  42.      to hold any sort of information desired by the user.
  43.  
  44.      Keywords that begin with "s-" apply to sections rather  than
  45.      tracks.   See  the  sections keyword below.  A CD entry with
  46.      "s-" keywords must have a sections keyword as well.  This is
  47.      done  for  backward compatibility and will disappear eventu-
  48.      ally, and in any case only  applies  to  keywords  found  in
  49.      .workmandb (the assumption is that users won't downgrade the
  50.      versions  they  run,  so  .workmanrc  doesn't  need  to   be
  51.      backward-compatible.)
  52.  
  53.      Some keywords are delimiters that  modify  the  meanings  of
  54.      keywords  that  follow;  others are position-independent and
  55.      may occur anywhere in the file.  (In general, the  position-
  56.      independent  keywords  are  concerned  with settings for the
  57.      tool as a whole, rather than for a particular disc.)
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Sun Release 4.1       Last change: 12/5/92                      1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. workmandb(5)              FILE FORMATS               workmandb(5)
  71.  
  72.  
  73.  
  74.      The keywords, and  their  arguments,  follow.   All  numeric
  75.      arguments are in decimal unless otherwise specified.
  76.  
  77.   Initial Keywords
  78.      These keywords must appear before the first CD's entry,  and
  79.      represent  global  settings  for the tool.  They are usually
  80.      found in .workmanrc.
  81.  
  82.      whendone eject | stop | repeat
  83.           Select the default action taken by _w_o_r_k_m_a_n(1) when a CD
  84.           is finished playing.  The default is stop.
  85.  
  86.      playnew
  87.           If specified, _w_o_r_k_m_a_n(1) will play unknown  CDs  (those
  88.           not listed in .workmanrc) when they're inserted.
  89.  
  90.   CD Information
  91.      The rest of the keywords describe specific CDs.
  92.  
  93.      tracks _n_t_r_a_c_k_s _s_t_a_r_t_1 _s_t_a_r_t_2 ... _s_t_a_r_t_n _l_e_n_g_t_h
  94.           This keyword delimits the start of  a  particular  CD's
  95.           entry  (and  thus  the end of the previous entry.)  Its
  96.           arguments contain the information used  to  distinguish
  97.           one disc from another.  The first argument, _n_t_r_a_c_k_s, is
  98.           the number of tracks on the  CD.   For  each  of  those
  99.           tracks,  there  is a _s_t_a_r_t value, which is the starting
  100.           frame of the track (a frame is approximately 1/75th  of
  101.           a  second.)  The final argument is the length of the CD
  102.           in seconds.
  103.  
  104.      sections _n_s_e_c_t_s _s_t_a_r_t_1 _s_t_a_r_t_2 ... _s_t_a_r_t_n
  105.           _W_o_r_k_m_a_n(1) allows the user to  split  a  CD's  physical
  106.           tracks  into  smaller  virtual  tracks called sections.
  107.           The sections keyword,  which  must  immediately  follow
  108.           tracks, defines the starting positions of the sections.
  109.           Sections are inserted into the track  list,  and  track
  110.           numbers  are  adjusted accordingly, e.g. section 1.2 as
  111.           presented to the user is represented as track 2 in  the
  112.           database  file.   If  the sections listed in .workmandb
  113.           and .workmanrc differ, .workmandb takes precedence, and
  114.           sections listed only in .workmanrc are discarded.
  115.  
  116.      cdname _n_a_m_e
  117.           The name of the current disc, as supplied by the user.
  118.  
  119.      artist _n_a_m_e
  120.           The artist's name for the current disc, as supplied  by
  121.           the user.
  122.  
  123.      playmode _m_o_d_e
  124.           The default play mode for the CD  is  _m_o_d_e,  a  numeric
  125.           value.   0  is  the "normal" play mode (play all tracks
  126.  
  127.  
  128.  
  129. Sun Release 4.1       Last change: 12/5/92                      2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. workmandb(5)              FILE FORMATS               workmandb(5)
  137.  
  138.  
  139.  
  140.           sequentially) and 1 is "shuffle" mode.  If _m_o_d_e is 2 or
  141.           greater,  the default play sequence is a playlist (_m_o_d_e
  142.           2 meaning the first playlist,  3  meaning  the  second,
  143.           etc.)
  144.  
  145.      autoplay
  146.           If autoplay is present,  this  CD  will  begin  playing
  147.           immediately when it is inserted.
  148.  
  149.      cdvolume _v_o_l_u_m_e
  150.           The default play volume of the CD, a value  from  0  to
  151.           32.   If  _v_o_l_u_m_e  is  0,  the  CD has no default volume
  152.           (since 0 is the default, cdvolume will usually  not  be
  153.           present in that case.)
  154.  
  155.      playlist _n_a_m_e _n_u_m_b_e_r _t_r_a_c_k_1 _t_r_a_c_k_2 ...
  156.           Define a playlist for the current CD.   The  _n_a_m_e  does
  157.           not  contain any whitespace; whitespace is converted to
  158.           "_" on output and "_" is  converted  to  whitespace  on
  159.           input.  (See the BUGS section.)  The _n_u_m_b_e_r argument is
  160.           the number of tracks contained  in  the  playlist;  the
  161.           rest of the line is a list of track numbers.  Playlists
  162.           are ordered; see the playmode keyword above.
  163.  
  164.      track [_n_a_m_e]
  165.           The name of a track.  This  delimits  the  start  of  a
  166.           track's information.  The _n_a_m_e argument is optional; it
  167.           will not be present unless  the  user  has  supplied  a
  168.           track  name.   This  line  may  be divided into display
  169.           lines with the "//"  token.   Additionally,  a  display
  170.           line  beginning with "+" indicates that the rest of the
  171.           display line contains a replacement disc title (usually
  172.           the name of a group of tracks, such as "Symphony No. 2"
  173.           on a disc with  more  than  one  piece  of  music.)   A
  174.           display  line  beginning with "@" replaces the artist's
  175.           name for the track.  If "+" or "@" is the only  charac-
  176.           ter on a display line, _w_o_r_k_m_a_n(1) will use the title or
  177.           artist from the previous track, searching backwards  as
  178.           necessary.  If a display line is empty, the correspond-
  179.           ing display line from the previous track is used.
  180.  
  181.      continue
  182.           The current track is a continuation of the previous one
  183.           (e.g. the second movement of a symphony.)
  184.  
  185.      dontplay _t_r_a_c_k
  186.           Don't play a track (specified by  number)  unless  it's
  187.           specifically requested by the user.
  188.  
  189.      volume _t_r_a_c_k _v_o_l_u_m_e
  190.           The default play volume for _t_r_a_c_k, specified by number.
  191.           _v_o_l_u_m_e is a number from 0 to 32.  See cdvolume above.
  192.  
  193.  
  194.  
  195. Sun Release 4.1       Last change: 12/5/92                      3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. workmandb(5)              FILE FORMATS               workmandb(5)
  203.  
  204.  
  205.  
  206.      mark _f_r_a_m_e _m_a_r_k-_i_d
  207.           Define a mark.  Marks with IDs other than START and END
  208.           are  currently  ignored.  Those two marks represent the
  209.           start and end of the part of the CD to be repeated  (as
  210.           set  from  the  Goodies popup) respectively.  The _f_r_a_m_e
  211.           value is an absolute frame number.
  212.  
  213. EXAMPLE
  214.      The first example is a .workmandb entry for  a  hypothetical
  215.      disc.  At least, I hope it's hypothetical.
  216.  
  217.           tracks 6 150 10341 20449 45117 100104 150100 1609
  218.           cdname Amazing Accordion Tunes - The Early Years
  219.           artist The Hemophiliacs
  220.           track Polka 'Till the Sun Goes Down
  221.           track I've Got Rocks In My Heart, Baby...
  222.           track ...But I Still Get Stoned On You
  223.           continue
  224.           track You Never Know How Late It Is Until the Clock Strikes Blue
  225.           track +The Big Exhibition//@Mussorgsky//IX. La Cabane//Allegro
  226.           track +//@////Andante mosso
  227.           continue
  228.  
  229.      The third track is a continuation of the second.  The  fifth
  230.      track  is  an excerpt from a larger work, originally written
  231.      by someone else; it has a two-line track title.   The  sixth
  232.      track is a continuation of the fifth; it uses the same title
  233.      and artist, and the first line of the  track  title  is  the
  234.      same, but the second is different.
  235.  
  236.      The .workmanrc entry for the same CD might look like:
  237.  
  238.           tracks 6 150 10341 20449 45117 100104 150100 1609
  239.           cdvolume 32
  240.           playmode 1
  241.           playlist Originals 3 2 3 1
  242.           autoplay
  243.           dontplay 4
  244.           volume 3 20
  245.  
  246.      The tracks line, naturally, is the same in both files, since
  247.      it  identifies  which CD the entry is for.  This CD plays at
  248.      maximum volume in shuffle mode by default.  It has one play-
  249.      list  with tracks 2, 3, and 1.  When inserted, it will start
  250.      up automatically.  Track 4 is  particularly  unpleasant,  so
  251.      the  user  never  wants  to  hear it.  And track 3 should be
  252.      played more quietly than the others.
  253.  
  254. SEE ALSO
  255.      workman(1)
  256.  
  257.  
  258.  
  259.  
  260.  
  261. Sun Release 4.1       Last change: 12/5/92                      4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. workmandb(5)              FILE FORMATS               workmandb(5)
  269.  
  270.  
  271.  
  272. BUGS
  273.      The playlist keyword is  not  well  thought-out.   The  _n_a_m_e
  274.      should  go  at  the  end of the line, so it can contain whi-
  275.      tespace or whatever else the user likes.
  276.  
  277.      The file updating algorithm used by  _w_o_r_k_m_a_n(1)  leaves  big
  278.      holes (consisting of empty lines) in the database files.  It
  279.      makes an attempt to fill the holes when possible rather than
  280.      growing the files.
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. Sun Release 4.1       Last change: 12/5/92                      5
  328.  
  329.  
  330.  
  331.